home *** CD-ROM | disk | FTP | other *** search
/ PC World 2007 September / PCWorld_2007-09_cd.bin / komunikace / firefox / Firefox Setup 2.0.0.6.exe / nonlocalized / components / nsSidebar.js < prev    next >
Encoding:
Text File  |  2007-07-25  |  14.5 KB  |  383 lines
  1. /* -*- Mode: C++; tab-width: 4; indent-tabs-mode: nil; c-basic-offset: 4 -*-
  2.  * ***** BEGIN LICENSE BLOCK *****
  3.  * Version: MPL 1.1/GPL 2.0/LGPL 2.1
  4.  *
  5.  * The contents of this file are subject to the Mozilla Public License Version
  6.  * 1.1 (the "License"); you may not use this file except in compliance with
  7.  * the License. You may obtain a copy of the License at
  8.  * http://www.mozilla.org/MPL/
  9.  *
  10.  * Software distributed under the License is distributed on an "AS IS" basis,
  11.  * WITHOUT WARRANTY OF ANY KIND, either express or implied. See the License
  12.  * for the specific language governing rights and limitations under the
  13.  * License.
  14.  *
  15.  * The Original Code is mozilla.org code.
  16.  *
  17.  * The Initial Developer of the Original Code is
  18.  * Netscape Communications Corporation.
  19.  * Portions created by the Initial Developer are Copyright (C) 1999
  20.  * the Initial Developer. All Rights Reserved.
  21.  *
  22.  * Contributor(s):
  23.  *   Stephen Lamm            <slamm@netscape.com>
  24.  *   Robert John Churchill   <rjc@netscape.com>
  25.  *   David Hyatt             <hyatt@mozilla.org>
  26.  *   Christopher A. Aillon   <christopher@aillon.com>
  27.  *   Myk Melez               <myk@mozilla.org>
  28.  *   Pamela Greene           <pamg.bugs@gmail.com>
  29.  *
  30.  * Alternatively, the contents of this file may be used under the terms of
  31.  * either the GNU General Public License Version 2 or later (the "GPL"), or
  32.  * the GNU Lesser General Public License Version 2.1 or later (the "LGPL"),
  33.  * in which case the provisions of the GPL or the LGPL are applicable instead
  34.  * of those above. If you wish to allow use of your version of this file only
  35.  * under the terms of either the GPL or the LGPL, and not to allow others to
  36.  * use your version of this file under the terms of the MPL, indicate your
  37.  * decision by deleting the provisions above and replace them with the notice
  38.  * and other provisions required by the GPL or the LGPL. If you do not delete
  39.  * the provisions above, a recipient may use your version of this file under
  40.  * the terms of any one of the MPL, the GPL or the LGPL.
  41.  *
  42.  * ***** END LICENSE BLOCK ***** */
  43.  
  44. /*
  45.  * No magic constructor behaviour, as is de rigeur for XPCOM.
  46.  * If you must perform some initialization, and it could possibly fail (even
  47.  * due to an out-of-memory condition), you should use an Init method, which
  48.  * can convey failure appropriately (thrown exception in JS,
  49.  * NS_FAILED(nsresult) return in C++).
  50.  *
  51.  * In JS, you can actually cheat, because a thrown exception will cause the
  52.  * CreateInstance call to fail in turn, but not all languages are so lucky.
  53.  * (Though ANSI C++ provides exceptions, they are verboten in Mozilla code
  54.  * for portability reasons -- and even when you're building completely
  55.  * platform-specific code, you can't throw across an XPCOM method boundary.)
  56.  */
  57.  
  58. const DEBUG = false; /* set to false to suppress debug messages */
  59.  
  60. const SIDEBAR_CONTRACTID            = "@mozilla.org/sidebar;1";
  61. const SIDEBAR_CID                   = Components.ID("{22117140-9c6e-11d3-aaf1-00805f8a4905}");
  62. const NETSEARCH_CONTRACTID          = "@mozilla.org/rdf/datasource;1?name=internetsearch"
  63. const nsISupports                   = Components.interfaces.nsISupports;
  64. const nsIFactory                    = Components.interfaces.nsIFactory;
  65. const nsISidebar                    = Components.interfaces.nsISidebar;
  66. const nsISidebar_MOZILLA_1_8_BRANCH = Components.interfaces.nsISidebar_MOZILLA_1_8_BRANCH;
  67. const nsISidebarExternal            = Components.interfaces.nsISidebarExternal;
  68. const nsIInternetSearchService      = Components.interfaces.nsIInternetSearchService;
  69. const nsIClassInfo                  = Components.interfaces.nsIClassInfo;
  70.  
  71. // File extension for Sherlock search plugin description files
  72. const SHERLOCK_FILE_EXT_REGEXP = /\.src$/i;
  73.  
  74. function nsSidebar()
  75. {
  76.     const PROMPTSERVICE_CONTRACTID = "@mozilla.org/embedcomp/prompt-service;1";
  77.     const nsIPromptService = Components.interfaces.nsIPromptService;
  78.     this.promptService =
  79.         Components.classes[PROMPTSERVICE_CONTRACTID].getService(nsIPromptService);
  80.  
  81.     const SEARCHSERVICE_CONTRACTID = "@mozilla.org/browser/search-service;1";
  82.     const nsIBrowserSearchService = Components.interfaces.nsIBrowserSearchService;
  83.     this.searchService =
  84.       Components.classes[SEARCHSERVICE_CONTRACTID].getService(nsIBrowserSearchService);
  85. }
  86.  
  87. nsSidebar.prototype.nc = "http://home.netscape.com/NC-rdf#";
  88.  
  89. function sidebarURLSecurityCheck(url)
  90. {
  91.     if (!/^(https?:|ftp:)/i.test(url)) {
  92.         Components.utils.reportError("Invalid argument passed to window.sidebar.addPanel: Unsupported panel URL." );
  93.         return false;
  94.     }
  95.     return true;
  96. }
  97.  
  98. /* decorate prototype to provide ``class'' methods and property accessors */
  99. nsSidebar.prototype.addPanel =
  100. function (aTitle, aContentURL, aCustomizeURL)
  101. {
  102.     debug("addPanel(" + aTitle + ", " + aContentURL + ", " +
  103.           aCustomizeURL + ")");
  104.    
  105.     return this.addPanelInternal(aTitle, aContentURL, aCustomizeURL, false);
  106. }
  107.  
  108. nsSidebar.prototype.addPersistentPanel = 
  109. function(aTitle, aContentURL, aCustomizeURL)
  110. {
  111.     debug("addPersistentPanel(" + aTitle + ", " + aContentURL + ", " +
  112.            aCustomizeURL + ")\n");
  113.  
  114.     return this.addPanelInternal(aTitle, aContentURL, aCustomizeURL, true);
  115. }
  116.  
  117. nsSidebar.prototype.addPanelInternal =
  118. function (aTitle, aContentURL, aCustomizeURL, aPersist)
  119. {
  120.     var WINMEDSVC = Components.classes['@mozilla.org/appshell/window-mediator;1']
  121.                               .getService(Components.interfaces.nsIWindowMediator);
  122.     var win = WINMEDSVC.getMostRecentWindow( "navigator:browser" );
  123.                                                                                 
  124.     if (!sidebarURLSecurityCheck(aContentURL))
  125.       return;
  126.  
  127.     var dialogArgs = {
  128.       name: aTitle,
  129.       url: aContentURL,
  130.       bWebPanel: true
  131.     }
  132.     var features;
  133.     if (!/Mac/.test(win.navigator.platform))
  134.       features = "centerscreen,chrome,dialog,resizable,dependent";
  135.     else
  136.       features = "chrome,dialog,resizable,modal";
  137.     win.openDialog("chrome://browser/content/bookmarks/addBookmark2.xul", "",
  138.                    features, dialogArgs);
  139. }
  140.  
  141. nsSidebar.prototype.validateSearchEngine =
  142. function (engineURL, iconURL)
  143. {
  144.   try
  145.   {
  146.     // Make sure we're using HTTP, HTTPS, or FTP.
  147.     if (! /^(https?|ftp):\/\//i.test(engineURL))
  148.       throw "Unsupported search engine URL";
  149.   
  150.     // Make sure we're using HTTP, HTTPS, or FTP and refering to a
  151.     // .gif/.jpg/.jpeg/.png/.ico file for the icon.
  152.     if (iconURL &&
  153.         ! /^(https?|ftp):\/\/.+\.(gif|jpg|jpeg|png|ico)$/i.test(iconURL))
  154.       throw "Unsupported search icon URL.";
  155.   }
  156.   catch(ex)
  157.   {
  158.     debug(ex);
  159.     Components.utils.reportError("Invalid argument passed to window.sidebar.addSearchEngine: " + ex);
  160.     
  161.     var searchBundle = srGetStrBundle("chrome://browser/locale/search.properties");
  162.     var brandBundle = srGetStrBundle("chrome://branding/locale/brand.properties");
  163.     var brandName = brandBundle.GetStringFromName("brandShortName");
  164.     var title = searchBundle.GetStringFromName("error_invalid_engine_title");
  165.     var msg = searchBundle.formatStringFromName("error_invalid_engine_msg",
  166.                                                 [brandName], 1);
  167.     var ww = Components.classes["@mozilla.org/embedcomp/window-watcher;1"].
  168.              getService(Components.interfaces.nsIWindowWatcher);
  169.     ww.getNewPrompter(null).alert(title, msg);
  170.     return false;
  171.   }
  172.   
  173.   return true;
  174. }
  175.  
  176. // The suggestedTitle and suggestedCategory parameters are ignored, but remain
  177. // for backward compatibility.
  178. nsSidebar.prototype.addSearchEngine =
  179. function (engineURL, iconURL, suggestedTitle, suggestedCategory)
  180. {
  181.   debug("addSearchEngine(" + engineURL + ", " + iconURL + ", " +
  182.         suggestedCategory + ", " + suggestedTitle + ")");
  183.  
  184.   if (!this.validateSearchEngine(engineURL, iconURL))
  185.     return;
  186.  
  187.   // OpenSearch files will likely be far more common than Sherlock files, and
  188.   // have less consistent suffixes, so we assume that ".src" is a Sherlock
  189.   // (text) file, and anything else is OpenSearch (XML).
  190.   var dataType;
  191.   if (SHERLOCK_FILE_EXT_REGEXP.test(engineURL))
  192.     dataType = Components.interfaces.nsISearchEngine.DATA_TEXT;
  193.   else
  194.     dataType = Components.interfaces.nsISearchEngine.DATA_XML;
  195.  
  196.   this.searchService.addEngine(engineURL, dataType, iconURL, true);
  197. }
  198.  
  199. // This function exists largely to implement window.external.AddSearchProvider(),
  200. // to match other browsers' APIs.  The capitalization, although nonstandard here,
  201. // is therefore important.
  202. nsSidebar.prototype.AddSearchProvider =
  203. function (aDescriptionURL)
  204. {
  205.   // Get the favicon URL for the current page, or our best guess at the current
  206.   // page since we don't have easy access to the active document.  Most search
  207.   // engines will override this with an icon specified in the OpenSearch
  208.   // description anyway.
  209.   var WINMEDSVC = Components.classes['@mozilla.org/appshell/window-mediator;1']
  210.                             .getService(Components.interfaces.nsIWindowMediator);
  211.   var win = WINMEDSVC.getMostRecentWindow("navigator:browser");
  212.   var browser = win.document.getElementById("content");
  213.   var iconURL = "";
  214.   if (browser.shouldLoadFavIcon(browser.selectedBrowser.currentURI))
  215.     iconURL = win.gProxyFavIcon.getAttribute("src");
  216.   
  217.   if (!this.validateSearchEngine(aDescriptionURL, iconURL))
  218.     return;
  219.  
  220.   const typeXML = Components.interfaces.nsISearchEngine.DATA_XML;
  221.   this.searchService.addEngine(aDescriptionURL, typeXML, iconURL, true);
  222. }
  223.  
  224. // This function exists to implement window.external.IsSearchProviderInstalled(),
  225. // for compatibility with other browsers.  It will return an integer value
  226. // indicating whether the given engine is installed for the current user.
  227. // However, it is currently stubbed out due to security/privacy concerns
  228. // stemming from difficulties in determining what domain issued the request.
  229. // See bug 340604 and
  230. // http://msdn.microsoft.com/workshop/author/dhtml/reference/methods/issearchproviderinstalled.asp .
  231. // XXX Implement this!
  232. nsSidebar.prototype.IsSearchProviderInstalled =
  233. function (aSearchURL)
  234. {
  235.   return 0;
  236. }
  237.  
  238. nsSidebar.prototype.addMicrosummaryGenerator =
  239. function (generatorURL)
  240. {
  241.     debug("addMicrosummaryGenerator(" + generatorURL + ")");
  242.  
  243.     var stringBundle = srGetStrBundle("chrome://browser/locale/sidebar/sidebar.properties");
  244.     var titleMessage = stringBundle.GetStringFromName("addMicsumGenConfirmTitle");
  245.     var dialogMessage = stringBundle.formatStringFromName("addMicsumGenConfirmText", [generatorURL], 1);
  246.       
  247.     if (!this.promptService.confirm(null, titleMessage, dialogMessage))
  248.         return;
  249.  
  250.     var ioService = Components.classes["@mozilla.org/network/io-service;1"].
  251.                     getService(Components.interfaces.nsIIOService);
  252.     var generatorURI = ioService.newURI(generatorURL, null, null);
  253.  
  254.     var microsummaryService = Components.classes["@mozilla.org/microsummary/service;1"].
  255.                               getService(Components.interfaces.nsIMicrosummaryService);
  256.     if (microsummaryService)
  257.       microsummaryService.addGenerator(generatorURI);
  258. }
  259.  
  260. // property of nsIClassInfo
  261. nsSidebar.prototype.flags = nsIClassInfo.DOM_OBJECT;
  262.  
  263. // property of nsIClassInfo
  264. nsSidebar.prototype.classDescription = "Sidebar";
  265.  
  266. // method of nsIClassInfo
  267. nsSidebar.prototype.getInterfaces = function(count) {
  268.     var interfaceList = [nsISidebar, nsISidebar_MOZILLA_1_8_BRANCH, 
  269.                          nsIClassInfo, nsISidebarExternal];
  270.     count.value = interfaceList.length;
  271.     return interfaceList;
  272. }
  273.  
  274. // method of nsIClassInfo
  275. nsSidebar.prototype.getHelperForLanguage = function(count) {return null;}
  276.  
  277. nsSidebar.prototype.QueryInterface =
  278. function (iid) {
  279.     if (!iid.equals(nsISidebar) && 
  280.         !iid.equals(nsIClassInfo) &&
  281.         !iid.equals(nsISupports) &&
  282.         !iid.equals(nsISidebar_MOZILLA_1_8_BRANCH) &&
  283.         !iid.equals(nsISidebarExternal))
  284.         throw Components.results.NS_ERROR_NO_INTERFACE;
  285.     return this;
  286. }
  287.  
  288. var sidebarModule = new Object();
  289.  
  290. sidebarModule.registerSelf =
  291. function (compMgr, fileSpec, location, type)
  292. {
  293.     debug("registering (all right -- a JavaScript module!)");
  294.     compMgr = compMgr.QueryInterface(Components.interfaces.nsIComponentRegistrar);
  295.  
  296.     compMgr.registerFactoryLocation(SIDEBAR_CID, 
  297.                                     "Sidebar JS Component",
  298.                                     SIDEBAR_CONTRACTID, 
  299.                                     fileSpec, 
  300.                                     location,
  301.                                     type);
  302.     const CATMAN_CONTRACTID = "@mozilla.org/categorymanager;1";
  303.     const nsICategoryManager = Components.interfaces.nsICategoryManager;
  304.     var catman = Components.classes[CATMAN_CONTRACTID].
  305.                             getService(nsICategoryManager);
  306.                             
  307.     const JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY = "JavaScript global property";
  308.     catman.addCategoryEntry(JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY,
  309.                             "sidebar",
  310.                             SIDEBAR_CONTRACTID,
  311.                             true,
  312.                             true);
  313.                             
  314.     catman.addCategoryEntry(JAVASCRIPT_GLOBAL_PROPERTY_CATEGORY,
  315.                             "external",
  316.                             SIDEBAR_CONTRACTID,
  317.                             true,
  318.                             true);
  319. }
  320.  
  321. sidebarModule.getClassObject =
  322. function (compMgr, cid, iid) {
  323.     if (!cid.equals(SIDEBAR_CID))
  324.         throw Components.results.NS_ERROR_NO_INTERFACE;
  325.     
  326.     if (!iid.equals(Components.interfaces.nsIFactory))
  327.         throw Components.results.NS_ERROR_NOT_IMPLEMENTED;
  328.     
  329.     return sidebarFactory;
  330. }
  331.  
  332. sidebarModule.canUnload =
  333. function(compMgr)
  334. {
  335.     debug("Unloading component.");
  336.     return true;
  337. }
  338.     
  339. /* factory object */
  340. var sidebarFactory = new Object();
  341.  
  342. sidebarFactory.createInstance =
  343. function (outer, iid) {
  344.     debug("CI: " + iid);
  345.     if (outer != null)
  346.         throw Components.results.NS_ERROR_NO_AGGREGATION;
  347.  
  348.     return (new nsSidebar()).QueryInterface(iid);
  349. }
  350.  
  351. /* entrypoint */
  352. function NSGetModule(compMgr, fileSpec) {
  353.     return sidebarModule;
  354. }
  355.  
  356. /* static functions */
  357. if (DEBUG)
  358.     debug = function (s) { dump("-*- sidebar component: " + s + "\n"); }
  359. else
  360.     debug = function (s) {}
  361.  
  362. var strBundleService = null;
  363. function srGetStrBundle(path)
  364. {
  365.    var strBundle = null;
  366.    if (!strBundleService) {
  367.        try {
  368.           strBundleService =
  369.           Components.classes["@mozilla.org/intl/stringbundle;1"].getService(); 
  370.           strBundleService = 
  371.           strBundleService.QueryInterface(Components.interfaces.nsIStringBundleService);
  372.        } catch (ex) {
  373.           dump("\n--** strBundleService failed: " + ex + "\n");
  374.           return null;
  375.       }
  376.    }
  377.    strBundle = strBundleService.createBundle(path); 
  378.    if (!strBundle) {
  379.        dump("\n--** strBundle createInstance failed **--\n");
  380.    }
  381.    return strBundle;
  382. }
  383.